Skip to main content

Sandbox Magic Values

Sandbox reserves a few values that trigger a specific outcome on purpose, so you can exercise the failure paths your integration has to handle without waiting for one to happen in production.

Generated page

The values below are generated from the same table the sandbox honours at runtime, so they cannot drift from what the environment actually does.

Scenarios

ScenarioTriggerYou observe
PIX pay-out to a blocked institution00000000-0000-4000-8000-000099999999PARTIAL-FAILED
PIX pay-out to a blocked real institution00000000-0000-4000-8000-000018236120PARTIAL-FAILED

PIX pay-out to a blocked institution

Pay out to a beneficiary whose bank is on the pay-out deny-list. Use it to exercise how your integration handles a delivery that fails after the ticket was paid.

PIX key00000000-0000-4000-8000-000099999999
Resolves to ISPB99999999
Ticket statusPARTIAL-FAILED
Failure reason containsreceiver bank institution is blocked

How to run it

  1. Register a BRL beneficiary using the PIX key above.
  2. Create a ticket paying out to that beneficiary.
  3. Wait for the delivery webhook, then read the ticket.
The beneficiary has to be registered by PIX key

A beneficiary registered with bank account details instead of a PIX key never goes through key resolution, so the magic value is never seen and the pay-out behaves normally.

You can confirm the institution is blocked for your account before you spend a ticket on it:

curl "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/blacklisted-ispbs" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

The response lists 99999999. It is a reserved code that belongs to no real institution, which is why it has no bank name.

PIX pay-out to a blocked real institution

The same delivery failure, but the beneficiary's bank is one you will recognise. Use it when you want the rehearsal to look like the real thing — a plausible bank name in your logs and screens — instead of a code that is obviously synthetic.

This bank is not blocked in production

The institution below is a real one, used here only so the rehearsal looks realistic. It is blocked in sandbox only, for this scenario. Nothing on this page says anything about which institutions are blocked for your account in production — check that with the endpoint below, against production.

PIX key00000000-0000-4000-8000-000018236120
Resolves to ISPB18236120
Ticket statusPARTIAL-FAILED
Failure reason containsreceiver bank institution is blocked

How to run it

  1. Register a BRL beneficiary using the PIX key above.
  2. Create a ticket paying out to that beneficiary.
  3. Wait for the delivery webhook, then read the ticket.
The beneficiary has to be registered by PIX key

A beneficiary registered with bank account details instead of a PIX key never goes through key resolution, so the magic value is never seen and the pay-out behaves normally.

You can confirm the institution is blocked for your account before you spend a ticket on it:

curl "https://api.sandbox.avenia.io:10952/v2/account/bank-accounts/brl/blacklisted-ispbs" \
-H "Authorization: Bearer eyJhdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

The response lists 18236120, resolved to NU PAGAMENTOS - IP — the same institution the pay-out will report. In sandbox only.

Simulation limits per currency

Sandbox also auto-settles deposits up to a cap that differs per currency, and uses mock account details for some rails. Those are documented with the flow they belong to: